事情|原代码_03注解是什么？——《Android打怪升级之旅》

篇首语：本文由编程笔记#小编为大家整理，主要介绍了03注解是什么？——《Android打怪升级之旅》相关的知识，希望对你有一定的参考价值。

感谢大家和我一起&＃xff0c;在android世界打怪升级&＃xff01;

注解非常的简单&＃xff0c;但又大量的出现在源码中。希望通过该文章&＃xff0c;能让大家看到注解不打怵&＃xff0c;明白如何自定义注解&＃xff0c;以及注解的作用&＃xff0c;一眼就能粗略的理解该注解的原理。

一、注解是什么

注解&＃xff08;Annotation&＃xff09;是JDK1.5引入的注释机制&＃xff0c;它本身没有任何意义&＃xff0c;仅仅是对代码的注释&＃xff0c;被修饰的代码不会被影响执行。

但是它和普通的代码注释又不同&＃xff0c;可以保留在各个时间段&＃xff08;源码、字节码、运行时&＃xff09;&＃xff0c;在各个时间段通过不同的技术&＃xff08;APT、字节码增强、反射&＃xff09;&＃xff0c;做不同的事情。

举一个简单的例子&＃xff1a;

&＃64;Override&＃xff1a;检查该方法是否是重写方法&＃xff0c;仅保留在源码阶段&＃xff0c;编译时判断如果父类和接口中没有该方法&＃xff0c;会报错。

二、自定义注解

咱们依然拿&＃64;Override注解举例&＃xff0c;下面是它的源码

&＃64;Target(ElementType.METHOD)
&＃64;Retention(RetentionPolicy.SOURCE)
public &＃64;interface Override



从上面代码我们看到了三个比较新的东西&＃xff0c;&＃64;Target、&＃64;Retention、&＃64;interface&＃xff0c;咱们一个个来说

2.1 关键字&＃xff1a;&＃64;interface

类使用class关键字修饰、接口使用interface关键字修饰、注解使用 &＃64;interface 关键字修饰。

2.2 元注解&＃xff1a;&＃64;Target

注解是用来注释代码的&＃xff0c;而元注解是用来注释注解的&＃xff0c;给自定义的注解增加一些限定范围。

&＃64;Target&＃xff1a;元注解之一&＃xff0c;限制注解的使用范围&＃xff0c;比如作用在属性、方法还是类上。接收的是一个数组&＃xff0c;可以指定多个范围。

可接收的范围&＃xff1a;

public enum ElementType
// 类、接口&＃xff08;包括注释类型&＃xff09;或枚举
TYPE,
// 字段&＃xff08;包括枚举常量&＃xff09;
FIELD,
// 方法
METHOD,
// 参数
PARAMETER,
// 构造方法
CONSTRUCTOR,
// 局部变量
LOCAL_VARIABLE,
// 注释类型
ANNOTATION_TYPE,
// 包
PACKAGE



举例&＃xff1a;

// 单个范围&＃xff0c;&＃64;Override仅可用在方法上
&＃64;Target(ElementType.METHOD)
public &＃64;interface Override

// 多个范围&＃xff0c;&＃64;Test可使用在 构造方法 和 方法 上
&＃64;Target(ElementType.CONSTRUCTOR, ElementType.METHOD)
public &＃64;interface Test



2.3 元注解&＃xff1a;&＃64;Retention

&＃64;Retention&＃xff1a;元注解之一&＃xff0c;保留级别&＃xff0c;设置该注解代码可以保留到什么阶段。

可保留的阶段&＃xff1a;

public enum RetentionPolicy
// 源码阶段&＃xff0c;在编译阶段存留&＃xff0c;在class字节码中会消除
SOURCE,
// 字节码阶段&＃xff0c;在class字节码存留&＃xff0c;在运行时消除
CLASS,
// 运行时阶段&＃xff0c;最长的阶段&＃xff0c;可以保留到虚拟机中
RUNTIME



举例&＃xff1a;

// &＃64;Override注解只能保存到源码阶段&＃xff0c;在生成class字节码中消除
&＃64;Retention(RetentionPolicy.SOURCE)
public &＃64;interface Override



2.4 自定义注解&＃xff1a;&＃64;Test

我们来实战一下&＃xff0c;需求如下&＃xff1a;

1. 可以保留到字节码阶段
2. 能作用在 字段 和 方法 上
3. 可以接收字符串数组参数

答案&＃xff1a;

// 注解定义
&＃64;Target(ElementType.METHOD, ElementType.FIELD)
&＃64;Retention(RetentionPolicy.CLASS)
public &＃64;interface Test
String[] value();

// 使用
public class TestAnnotation
&＃64;Test("test")
private String name;
&＃64;Test("test1", "test2")
public void test()




三、注解的作用

文章的开头我们提到过&＃xff0c;注解保留在各个时间段&＃xff08;源码、字节码、运行时&＃xff09;&＃xff0c;在各个时间段通过不同的技术&＃xff08;APT、字节码增强、反射&＃xff09;&＃xff0c;做不同的事情。

我们这里不对技术进行详解&＃xff0c;只对其做个概述&＃xff0c;大家知道能做什么即可&＃xff0c;如果有兴趣可以去深入学习。

3.1 源码阶段 —— APT&＃xff08;注解处理器&＃xff09;

APT&＃xff08;Annotation Processing Tool&＃xff09;&＃xff0c;注解处理器&＃xff0c;简单来说就是在编译时寻找被该注解注释的代码&＃xff0c;获取注解上的信息&＃xff0c;通过某种方式进行提醒或者生成Java代码&＃xff08;不能修改原代码&＃xff0c;如&＃xff1a;JavaPoet&＃xff09;。比如路由注解就是通过编译时生成代码统一注册的。

ButterKnife、EventBus、ARouter等框架用的都是该技术&＃xff0c;但是大家更喜欢把保留级别指定在字节码和运行时&＃xff0c;因为一定会包括源码阶段。

3.2 字节码阶段 —— 字节码增强

就是修改字节码&＃xff0c;在生成的class字节码阶段&＃xff0c;可以对当前被注释的方法进行修改增强。比如我们写一个&＃64;NeedLogin注释在一个需要登录的方法外面&＃xff0c;在生成字节码后可以对该方法的前后进行字节码插入&＃xff0c;以达到登录的目的。

// 初始代码
&＃64;NeedLogin
public void test()
System.out.println("你好");

// 被字节码增强后
public void test()
if (!isLogin)
// 打开登录页
return;

System.out.println("你好");



3.3 运行时阶段 —— 反射

在运行时可以通过反射获取注解的信息和元素&＃xff0c;根据这些可以做不同的逻辑判定。

总结

最后咱们再总结一下注解的知识点&＃xff1a;

1. 注解是JDK1.5引入的注释机制&＃xff0c;本身没有任何意义。
2. 注解使用&＃64;interface关键字修饰&＃xff0c;使用&＃64;Target指定限定范围&＃xff08;方法、属性等&＃xff09;&＃xff0c;使用&＃64;Retention指定保留阶段&＃xff08;源码、字节码、运行时&＃xff09;。
3. 注解可以在源码阶段使用APT&＃xff0c;在字节码阶段使用字节码增强&＃xff0c;在运行时阶段使用反射。

这样注解的介绍就结束了&＃xff0c;希望大家读完这篇文章&＃xff0c;会对注解有一个更深入的了解。如果我的文章能给大家带来一点点的福利&＃xff0c;那在下就足够开心了。

下次再见&＃xff01;